Classes and functions index

Here we list the most important classes and functions.

Parameters

silq.parameters

AcquisitionParameters

silq.parameters.acquisition_parameters

acquisition_parameters

AcquisitionParameter

Parameter used for acquisitions involving a PulseSequence.

DCParameter

Acquires DC voltage

TraceParameter

An acquisition parameter for obtaining a trace or multiple traces of a given PulseSequence.

VariableReadParameter

Parameter for measuring spin tails.

EPRParameter

Parameter for an empty-plunge-read sequence.

ESRParameter

Parameter for most pulse sequences involving electron spin resonance.

T2ElectronParameter

Parameter for measuring electron decoherence.

NMRParameter

Parameter for most measurements involving an NMR pulse.

FlipNucleusParameter

FlipFlopParameter

Parameter for performing flip-flopping, not meant for acquiring data

BlipsParameter

Parameter that measures properties of blips in a trace

PulseSequenceAcquisitionParameter

DCSweepParameter

Perform 1D and 2D DC sweeps by rapidly varying AWG output voltages

General Parameters

silq.parameters.general_parameters

CombinedParameter

Combines multiple parameters into a single parameter.

AttributeParameter

Creates a parameter that can set/get an attribute from an object.

MeasurementParameters

silq.parameters.measurement_parameters

MeasurementParameter

Base class for parameters that perform measurements.

CoulombPeakParameter

Parameter that finds Coulomb peak and can tune to it.

RetuneBlipsParameter

Parameter that retunes by analysing blips using a neural network

MeasureNucleusParameter

MeasureFlipNucleusParameter

DCMultisweepParameter

MeasurementSequenceParameter

SelectFrequencyParameter

TrackPeakParameter

Pulses and PulseSequences

Pulse types

silq.pulses.pulse_types

Pulse

Representation of physical pulse, component in a PulseSequence.

DCPulse

DC (fixed-voltage) Pulse.

SinePulse

Sinusoidal pulse

TriggerPulse

Triggering pulse.

DCRampPulse

Linearly ramping voltage Pulse.

FrequencyRampPulse

Linearly increasing/decreasing frequency Pulse.

MarkerPulse

Marker pulse

MeasurementPulse

Pulse that is only used to signify an acquiition

PulsesSequences

silq.pulses.pulse_modules

PulseSequence([pulses, …])

Pulse container that can be targeted in the Layout.

PulseSequence generators

silq.pulses.pulse_sequences

PulseSequenceGenerator([pulses])

Base class for a PulseSequence that is generated from settings.

ESRPulseSequence(**kwargs)

PulseSequenceGenerator for electron spin resonance (ESR).

T2ElectronPulseSequence(**kwargs)

PulseSequenceGenerator for electron coherence (T2) measurements.

NMRPulseSequence([pulses])

PulseSequenceGenerator for nuclear magnetic resonance (NMR).

FlipFlopPulseSequence(**kwargs)

PulseSequenceGenerator for hitting the flip-flop transition

Analysis

silq.analysis

Analysis functions

silq.analysis.analysis

find_high_low

Find high and low voltages of traces using histograms

edge_voltage

Test traces for having a high/low voltage at begin/end

find_up_proportion

Determine the up proportion of traces (traces that have blips)

count_blips

Count number of blips and durations in high/low state.

analyse_traces

Analyse voltage, up proportions, and blips of acquisition traces

analyse_EPR

Analyse an empty-plunge-read sequence

analyse_flips

Analyse flipping between NMR states

Fitting functions

silq.analysis.fit_toolbox

Fit

Base fitting class.

LinearFit

Fitting class for a linear function.

ExponentialFit

Fitting class for an exponential function.

DoubleExponentialFit

Fitting class for a double exponential function.

SineFit

AMSineFit

ExponentialSineFit

RabiFrequencyFit

Tools

silq.tools

General tools

silq.tools.general_tools

run_code

Creates cell to run code from global variable code_labels

SettingsClass

Class used to temporarily override attributes.

is_between

Check if value is between min and max, taking machine precision into account

Notebook tools

silq.tools.notebook_tools

create_cell

Create code cell in Jupyter Notebook and optionally execute.

SilQMagics

IPyton magics related to code management (loading, saving, editing, …).

Plot tools

silq.tools.plot_tools

PlotAction

Interactive key/button action for MatPlot

SetGates

Set gates when button pressed in MatPlot, enabled with alt + g.

MeasureSingle

Measure parameter at clicked gate vales, enabled with alt + s

MoveGates

Increase/decrease gates when pressing alt + {arrow}, enabled with alt+m.

SwitchPlotIdx

Change plot index when pressing alt+{arrow}, used with SliderPlot.

InteractivePlot

Base class for MatPlot plots adding interactivity.

SliderPlot

Slide through 1D/2D images of a DataArray with more dimensions.

CalibrationPlot

Interactive plot for 2D calibrations, move gates and measure at points.

DCPlot

Interactive plot for a 2D DC scan, For easy moving gates on 2D plot.

ScanningPlot

Base class for interactive plots to repeatedly measure and refresh plot.

TracePlot

Interactive plot that repeatedly measures pulse sequence and plots trace

DCSweepPlot

Refreshing 2D DC plot using DCSweepParameter for fast 2D DC scanning.

Detect peaks

silq.tools.detect_peaks

find_transitions

Locate transitions within a 2-dimensional charge stability diagram

get_charge_transfer_information

Calculate information about a particular charge transfer event.

plot_transitions

plot_transition_gradient